home *** CD-ROM | disk | FTP | other *** search
/ Total History! / Total History! - Disc 1.iso / title.mst < prev    next >
Text File  |  1995-06-10  |  18KB  |  520 lines
  1.  '**************************************************************************
  2. '*
  3. '* TITLE.MST - Viewer Runtime Setup Script
  4. '*
  5. '* CUSTOMIZING TITLE.MST
  6. '*
  7. '* For a simple Setup routine, you just need to assign values to the 
  8. '* series of variables following the heading "Setup Variables". This
  9. '* script also provides for the following more-advanced options, which
  10. '* are supported by subroutines located later in this script:
  11. '*
  12. '* Option                                         See Subroutine
  13. '* ------------------------------------------     ---------------------
  14. '* Install more than one .MVB file                ModifyViewerIni
  15. '* Install Help title                             ModifyViewerIni
  16. '* Install custom DLLs                            ModifyViewerIni
  17. '* Install multiple Program Manager items         ModifyProgramManager
  18. '* Display a custom icon with the ProgMan item    ModifyProgramManager
  19. '* Install custom fonts                           RegisterCustomFonts
  20. '* Install Video for Windows runtime files        RegisterDrivers
  21. '*
  22. '* Each customization note starts with the heading CUSTOMIZATION.
  23. '*
  24. '**************************************************************************
  25.     
  26.     '' Global variables
  27.  
  28.     GLOBAL TitleShortName$
  29.     GLOBAL TitleLongName$
  30.     GLOBAL MVBFileName$
  31.     GLOBAL PromptForPath%
  32.     GLOBAL DefaultPath$
  33.     GLOBAL ProgManGroup$
  34.     GLOBAL ProgManItem$
  35.  
  36.     '' ****************************************************************
  37.     '' ** Setup Variables
  38.     '' ****************************************************************
  39.  
  40.     '' Set the following string to a short form of the title name
  41.     '' (for example, "Gallery")
  42.     
  43.     TitleShortName$ = "Multimedia U.S. History"
  44.     
  45.     '' Set the following string to a long form of the title name
  46.     '' (for example, "Viewer 2.0 Gallery")
  47.     
  48.     TitleLongName$ = "Multimedia U.S. History"
  49.         
  50.     '' Set the following variable to the name of the MVB file, without 
  51.     '' the filename extension (for example, "GALLERY")
  52.         
  53.     MVBFileName$ = "mmush"
  54.         
  55.     '' The following variable determines whether Setup prompts the user
  56.     '' to specify a directory in which to install title files. (Files
  57.     '' to be installed on the hard disk must be listed in the TITLE.INF 
  58.     '' file under the [Installed Title Files] section.) Specify one of
  59.     '' the following values:
  60.     ''
  61.     '' 0    Install title files in the Windows directory (default setting).
  62.     ''      This is an appropriate setting if you have a limited number
  63.     ''      of files to copy (for example, a single custom icon or DLL).
  64.     ''
  65.     '' 1    Display a dialog box to prompt the user for a directory in 
  66.     ''      which to install files
  67.         
  68.     PromptForPath% = 1
  69.         
  70.     '' If you have specified 1 in PromptForPath%, set the following 
  71.     '' variable to the default path that will be displayed in the dialog
  72.     '' box (for example, "C:\GALLERY").
  73.         
  74.     DefaultPath$ = "C:\MMUSH"
  75.     
  76.     '' Set the following variable to the name of the program manager 
  77.     '' group you would like to create (for example, "Viewer 2.0 Gallery")
  78.         
  79.     ProgManGroup$ = "Bureau Multimedia"
  80.     
  81.     '' Set the following variable to the caption of the program manager 
  82.     '' item for your title (for example, "Gallery")
  83.         
  84.     ProgManItem$ = "Multimedia U.S. History"
  85.     
  86.     '***********************************************************************
  87.     '** Mainline
  88.     '***********************************************************************
  89.  
  90.     GLOBAL CUIDLL$
  91.  
  92.     '' Include files
  93.     '$INCLUDE 'setupapi.inc'
  94.     
  95.     '' Custom UI dll
  96.     CUIDLL$ = "mscuistf.dll"
  97.     
  98.     '' Dialog ID's
  99.     CONST DESTPATH      = 1000
  100.     CONST APPHELP       = 2000
  101.     CONST TOOBIG        = 3000
  102.     CONST BADPATH       = 4000
  103.     CONST SUCCESS       = 5000
  104.     
  105.     '' Bitmap ID
  106.     CONST LOGO = 1
  107.     
  108.     '' Functions and subroutines
  109.     DECLARE FUNCTION AddFont LIB "mscuistf.dll" (szFont$, szName$) AS INTEGER
  110.     DECLARE FUNCTION MakePath (szDir$, szFile$) AS STRING
  111.     DECLARE FUNCTION GetTitleDir (szDefault$) AS STRING
  112.     DECLARE FUNCTION CopyFiles(szTitleDir$) AS INTEGER
  113.     DECLARE SUB RegisterFont(fontfile$, fontname$)
  114.     DECLARE SUB ModifyViewerIni(szTitleDir$)
  115.     DECLARE SUB RegisterCustomFonts
  116.     DECLARE SUB ModifyProgramManager
  117.     DECLARE SUB ShowSuccess
  118.     DECLARE SUB RegisterDrivers
  119.     
  120.     '' The following statement turns size checking off. Set it to scmOnFatal 
  121.     '' to enable size checking, where Setup will compare the disk file size 
  122.     '' with the INF file size and report an error if they are not the same.
  123.     
  124.     i% = SetSizeCheckMode(scmOff)
  125.     
  126.     '' Set the title and banner bitmap. You must rebuild MSCUISTF.DLL to 
  127.     '' alter the banner bitmap.
  128.     
  129.     SetTitle "Bureau Title Setup"
  130.     SetBitmap CUIDLL$, LOGO 
  131.     
  132.     '' Read in the INF file.
  133.     
  134.     ReadInfFile GetSymbolValue("STF_CWDDIR") + "TITLE.INF"
  135.     
  136.     '' Decide where to put title files
  137.     IF PromptForPath% = 1 THEN
  138.         szTitleDir$ = GetTitleDir(DefaultPath$)
  139.         IF szTitleDir$ = "" THEN
  140.             GOTO QUIT
  141.         ENDIF
  142.     ELSE
  143.         szTitleDir$ = GetWindowsDir()
  144.     ENDIF   
  145.     
  146.     '' Copy files
  147.     IF CopyFiles(szTitleDir$) = 0 THEN
  148.         GOTO QUIT
  149.     ENDIF
  150.  
  151.     '' Create the MVIEWER2.EXE MVB association 
  152.     CreateIniKeyValue "WIN.INI", "Extensions", "MVB", "mviewer2.exe", cmoNone
  153.  
  154.     '' Register in VIEWER.INI
  155.     ModifyViewerIni szTitleDir$
  156.  
  157.     '' Register custom fonts
  158.     RegisterCustomFonts
  159.  
  160.     '' Register drivers
  161.     RegisterDrivers
  162.     
  163.     '' Modify Program Manager
  164.     ModifyProgramManager    
  165.     
  166.     '' Success dialog
  167.     ShowSuccess
  168.     
  169.     '' Now start the title
  170.  
  171.     RUN "fixcache.exe"
  172. QUIT:
  173.     
  174.     END
  175.     
  176.  
  177. '*************************************************************************
  178. '** Purpose:
  179. '**     Prompts the user for a path for the title files
  180. '** Arguments:
  181. '**     szDefault$ - default path
  182. '** Returns:
  183. '**     New valid path name, or "" if the user quit.
  184. '*************************************************************************
  185.  
  186. FUNCTION GetTitleDir (szDefault$) STATIC AS STRING
  187.  
  188.     SetSymbolValue "String", TitleShortName$
  189.     SetSymbolValue "EditTextIn", szDefault$
  190.     SetSymbolValue "EditFocus", "ALL"
  191.  
  192.     GETPATH:
  193.  
  194.     sz$ = UIStartDlg(CUIDLL$, DESTPATH, "FEditDlgProc", APPHELP, "FHelpDlgProc")
  195.  
  196.     IF sz$ = "CONTINUE" THEN
  197.         szTitleDir$ = GetSymbolValue("EditTextOut")
  198.         IF IsDirWritable(szTitleDir$) = 0 THEN
  199.  
  200.             BADPATH:
  201.  
  202.             sz$ = UIStartDlg(CUIDLL$, BADPATH, "FInfoDlgProc", 0, "")
  203.             IF sz$ = "REACTIVATE" THEN
  204.                 GOTO BADPATH
  205.             END IF
  206.             UIPop 1
  207.             GOTO GETPATH
  208.         END IF
  209.         UIPop 1
  210.         CreateDir szTitleDir$, cmoNone
  211.  
  212.     ELSEIF sz$ = "REACTIVATE" THEN
  213.         GOTO GETPATH
  214.  
  215.     ELSE
  216.         szTitleDir$ = ""
  217.  
  218.     END IF
  219.  
  220.     GetTitleDir = szTitleDir$
  221.  
  222. END FUNCTION
  223.  
  224.  
  225. '*************************************************************************
  226. '** Purpose:
  227. '**     Copies the files in the INF file
  228. '** Arguments:
  229. '**     szTitleDir$ - destination directory for the title files
  230. '** Returns
  231. '**     1 if files were copied, 0 otherwise
  232. '*************************************************************************
  233.  
  234. FUNCTION CopyFiles(szTitleDir$) STATIC AS INTEGER
  235.  
  236.     '' Add all system files to the copy list
  237.     AddSectionFilesToCopyList "System Files", GetSymbolValue("STF_SRCDIR"), GetWindowsSysDir()    
  238.     '' Add all of the title files to the copy list
  239.     AddSectionFilesToCopyList "Installed Title Files", GetSymbolValue("STF_SRCDIR"), szTitleDir$
  240.     
  241.     '' Check size
  242.     szExtras$ = "Extra"
  243.     szCosts$ = "Costs"
  244.     szNeededs$ = "Neededs"
  245.     FOR i% = 1 TO 26 STEP 1
  246.         AddListItem szExtras$, "0"
  247.     NEXT i%
  248.     
  249.     '' We assume that VIEWER.INI will take another 4K
  250.     ReplaceListItem szExtras$, ASC(MID$(GetWindowsDir(), 1, 1)) - ASC("A") + 1, STR$(4096)
  251.     
  252.     '' Get amount of space required
  253.     StillNeed& = GetCopyListCost(szExtras$, szCosts$, szNeededs$)
  254.     
  255.     '' Put up a message if there is not enough space
  256.     FOR i% = 1 TO 26 STEP 1
  257.         IF VAL(GetListItem(szNeededs$, i%)) > 0 THEN
  258.     
  259.             SetSymbolValue "String1", LTRIM$(STR$(VAL(GetListItem(szCosts$, i%)) / 1024))
  260.             SetSymbolValue "String2", CHR$(i% - 1 + ASC("A"))
  261.     
  262.             TOOBIG:
  263.     
  264.             sz$ = UIStartDlg(CUIDLL$, TOOBIG, "FInfoDlgProc", 0, "")
  265.             IF sz$ = "REACTIVATE" THEN
  266.                 GOTO TOOBIG
  267.             END IF
  268.             UIPop 1
  269.             CopyFiles = 0
  270.             GOTO DONTCOPY
  271.         END IF
  272.     NEXT i%
  273.     
  274.     '' Copy the files
  275.     CopyFilesInCopyList
  276.     
  277.     CopyFiles = 1
  278.  
  279. DONTCOPY:
  280.  
  281. END FUNCTION
  282.  
  283.  
  284. '*************************************************************************
  285. '** Purpose:
  286. '**     Puts up a success dialog
  287. '*************************************************************************
  288.  
  289. SUB ShowSuccess STATIC
  290.  
  291.     SUCCESS:
  292.     
  293.     SetSymbolValue "String1", TitleShortName$
  294.     sz$ = UIStartDlg(CUIDLL$, SUCCESS, "FInfoDlgProc", 0, "")
  295.     IF sz$ = "REACTIVATE" THEN
  296.         GOTO SUCCESS
  297.     END IF
  298.     UIPop 1
  299.     
  300. END SUB
  301.  
  302.  
  303. '*************************************************************************
  304. '** Purpose:
  305. '**     Appends a file name to the end of a directory path,
  306. '**     inserting a backslash character as needed.
  307. '** Arguments:
  308. '**     szDir$  - full directory path (with optional ending "\")
  309. '**     szFile$ - filename to append to directory
  310. '** Returns:
  311. '**     Resulting fully qualified path name.
  312. '*************************************************************************
  313.  
  314. FUNCTION MakePath (szDir$, szFile$) STATIC AS STRING
  315.     IF szDir$ = "" THEN
  316.         MakePath = szFile$
  317.     ELSEIF szFile$ = "" THEN
  318.         MakePath = szDir$
  319.     ELSEIF MID$(szDir$, LEN(szDir$), 1) = "\" THEN
  320.         MakePath = szDir$ + szFile$
  321.     ELSE
  322.         MakePath = szDir$ + "\" + szFile$
  323.     END IF
  324. END FUNCTION
  325.  
  326.  
  327. '*************************************************************************
  328. '** Purpose:
  329. '**     Registers a font.
  330. '** Arguments:
  331. '**     fontfile$ - font filename
  332. '**     fontname$ - font name.
  333. '*************************************************************************
  334.  
  335. SUB RegisterFont(fontfile$, fontname$) STATIC
  336.  
  337.     '' A simple error catching wrapper around AddFont, which is a 'C' routine in MSCUISTF.DLL
  338.  
  339.    IF AddFont(fontfile$, fontname$) = -1 THEN
  340.         j% = DoMsgBox("This font is already installed " + fontfile$ + " font.", "Viewer Font Installation", 0)
  341.    ENDIF
  342.  
  343. END SUB
  344.  
  345.  
  346. '*************************************************************************
  347. '** Purpose:
  348. '**     Registers title in VIEWER.INI
  349. '*************************************************************************
  350.  
  351. SUB ModifyViewerIni (szTitleDir$) STATIC
  352.  
  353.     '' Get the VIEWER.INI file
  354.     
  355.     szIni$ = MakePath(GetWindowsDir(), "VIEWER.INI")
  356.  
  357.     '' First register the title file, setting the Name and Path entries. 
  358.     '' We assume that the MVB file is the same directory as SETUP.EXE.
  359.     ''
  360.     '' CUSTOMIZATION: If you're installing multiple MVB files, copy the
  361.     '' following two statements for each additional file, substituting
  362.     '' the appropriate long name and MVB filename for the TitleLongName$
  363.     '' and MVBFileName$ variables.
  364.     
  365.     CreateIniKeyValue szIni$, MVBFileName$, "Name", TitleLongName$, cmoOverwrite
  366.     CreateIniKeyValue szIni$, MVBFileName$, "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  367.  
  368.     CreateIniKeyValue szIni$, "MUSHHELP.MVB", "Name", "Multimedia U.S. History Help", cmoOverwrite
  369.     CreateIniKeyValue szIni$, "MUSHHELP.MVB", "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  370.  
  371.     CreateIniKeyValue szIni$, "LAUNCHEX.DLL", "Name", "Launchex.dll", cmoOverwrite
  372.     CreateIniKeyValue szIni$, MVBFileName$, "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  373.  
  374.     CreateIniKeyValue szIni$, "TSTOOLS2.DLL", "Name", "Tstools2.dll", cmoOverwrite
  375.     CreateIniKeyValue szIni$, MVBFileName$, "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  376.  
  377.     CreateIniKeyValue szIni$, "TSDATA.DLL", "Name", "Tsdata.dll", cmoOverwrite
  378.     CreateIniKeyValue szIni$, MVBFileName$, "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  379.  
  380.  
  381.     CreateIniKeyValue szIni$, "DEINSTAL.DLL", "Name", "Deinstal.dll", cmoOverwrite
  382.     CreateIniKeyValue szIni$, MVBFileName$, "Path", GetSymbolValue("STF_SRCDIR"), cmoOverwrite
  383.  
  384.         CreateIniKeyValue szIni$, "TOUR-SEARCH DIALOG HELP", "mmush", "JumpID(`mmush.mvb>w_help',`search_help')", cmoOverwrite
  385.  
  386.     CreateIniKeyValue szIni$, "TOUR-SEARCH DIALOG TOURS", "Small Tour", "mmtour1", cmoOverwrite
  387.     CreateIniKeyValue szIni$, "TOUR-SEARCH DIALOG TOURS", "Medium Tour", "mmtour2", cmoOverwrite
  388.     CreateIniKeyValue szIni$, "TOUR-SEARCH DIALOG TOURS", "Large Tour", "mmtour3", cmoOverwrite
  389.     
  390.   
  391.     '' Now we have to register the MVB file in the [FILES] section, so 
  392.     '' Viewer can find files that are not on the path and display a 
  393.     '' special message when a file is not found.
  394.  
  395.     CreateIniKeyValue szIni$, "FILES", MVBFileName$ + ".MVB", GetSymbolValue("STF_SRCDIR") + "," + "Please insert the " + TitleLongName$ + " disk.", cmoOverwrite
  396.     
  397.     CreateIniKeyValue szIni$, "FILES","MUSHHELP.MVB", GetSymbolValue("STF_SRCDIR") + "," + "Please insert the " + TitleLongName$ + " disk.", cmoOverwrite
  398.  
  399.  
  400.  
  401.     '' CUSTOMIZATION: If you're installing a Help title or any custom DLLs,
  402.     '' you should copy the preceding statement for each extra title or DLL.    ''
  403.     '' Example for installing an extra title:
  404.     ''
  405.      '' CreateIniKeyValue szIni$, "FILES", "GALHELP.MVB", GetSymbolValue("STF_SRCDIR") + "," + "Please insert the Viewer 2.0 Gallery disk.", cmoOverwrite
  406.     ''
  407.     '' Example for installing a custom DLL:
  408.          CreateIniKeyValue szIni$, "FILES", "LAUNCHEX.DLL", szTitleDir$ + "\," + "A required file is missing. Please reinstall Multimedia U.S. History.", cmoOverwrite
  409.  
  410.          CreateIniKeyValue szIni$, "FILES", "USHTIME.EXE", szTitleDir$ + "\," + "A required file is missing. Please reinstall Multimedia U.S. History.", cmoOverwrite
  411.  
  412.          CreateIniKeyValue szIni$, "FILES", "TOURSRCH.DLL", szTitleDir$ + "\," + "A required file is missing. Please reinstall Multimedia U.S. History.", cmoOverwrite
  413.  
  414.          CreateIniKeyValue szIni$, "FILES", "EPLIST.DLL", szTitleDir$ + "\," + "A required file is missing. Please reinstall Multimedia U.S. History.", cmoOverwrite
  415.  
  416.          CreateIniKeyValue szIni$, "FILES", "NETCHECK.DLL", szTitleDir$ + "\," + "A required file is missing. Please reinstall Multimedia U.S. History.", cmoOverwrite
  417.  
  418. END SUB
  419.  
  420.  
  421. '*************************************************************************
  422. '** Purpose:
  423. '**     Creates program manager entries for the title
  424. '*************************************************************************
  425.  
  426. SUB ModifyProgramManager STATIC
  427.  
  428.     '' Create the program manager group
  429.  
  430.     CreateProgmanGroup ProgmanGroup$, "", cmoNone
  431.     ShowProgmanGroup ProgmanGroup$, 1, cmoNone
  432.     
  433.     '' Create an entry for the title
  434.      
  435. CreateProgmanItem ProgmanGroup$, ProgmanItem$, "mviewer2.exe " + MakePath(GetSymbolValue("STF_SRCDIR"), MVBFileName$ + ".MVB"), MakePath(GetSymbolValue("STF_SRCDIR"), "bureau.ico"), cmoOverwrite
  436.  
  437. CreateProgmanItem ProgmanGroup$, "Multimedia U.S. History", "mviewer2.exe " + MakePath(GetSymbolValue("STF_SRCDIR"), "MMUSH.MVB"), MakePath(GetSymbolValue("STF_SRCDIR"), "MMUSH.ICO"), cmoOverwrite
  438.  
  439.     '' CUSTOMIZATION: 
  440.     ''
  441.     '' To create additional Program Manager items, copy the preceding 
  442.     '' statement for each additional item, substituting the appropriate
  443.     '' Program Manager item name for ProgmanItem$ and filename for 
  444.     '' MVBFileName$.
  445.     ''
  446.     '' To display a custom icon with the Program Manager item, specify
  447.     '' the icon filename with the fourth parameter (this parameter is 
  448.     '' currently an empty string, ""). The following example specifies 
  449.     '' an icon with the same filename as the .MVB file:
  450.     ''
  451.     ''       CreateProgmanItem ProgmanGroup$, ProgmanItem$, "mviewer2.exe " + MakePath(GetSymbolValue("STF_SRCDIR"), MVBFileName$ + ".MVB"), MakePath(GetSymbolValue("STF_SRCDIR"), MVBFileName$ + ".ICO"), cmoOverwrite
  452.  
  453.  
  454. END SUB
  455.  
  456.  
  457. '*************************************************************************
  458. '** Purpose:
  459. '**     Registers custom fonts with Windows.
  460. '*************************************************************************
  461.  
  462. SUB RegisterCustomFonts STATIC
  463.  
  464.     '' CUSTOMIZATION: If you install custom fonts, then add statements
  465.     '' in this routine to register the fonts with the current Windows 
  466.     '' session and to add them to the WIN.INI [Fonts] section. 
  467.     ''
  468.     '' Note that TrueType fonts can only be installed in Windows 3.1.
  469.     '' RegisterFont automatically creates the required .FOT file for 
  470.     '' TrueType fonts.
  471.     ''    
  472.     '' The following example registers a font residing in MISTRAL.TTF
  473.     '' and installs the font with the name Mistral (True Type):
  474.     '' 
  475.     RegisterFont "southrnn.ttf","Southern (TrueType)"
  476.      RegisterFont "timpanin.ttf","Timapni (TrueType)"
  477.     RegisterFont "expon.ttf","Expo (TrueType)"
  478.     RegisterFont "paradisn.ttf","Paradise (TrueType)"
  479.     RegisterFont "gallerin.ttf","Galleria (TrueType)"
  480.     ''
  481.  
  482. END SUB
  483.  
  484.  
  485. '*************************************************************************
  486. '** Purpose:
  487. '**     Registers Windows drivers
  488. '*************************************************************************
  489.  
  490. SUB RegisterDrivers STATIC
  491.  
  492. '' CUSTOMIZATION: Video for Windows is not a standard component of
  493. '' Windows 3.1. If your title uses video, proceed as follows.
  494. ''
  495. '' 1) Add the following files to the [System Files] section of the INF file:
  496. ''
  497. ''    dispdib.dll
  498. ''    msvideo.dll
  499. ''    indeo.drv
  500. ''    mciavi.drv
  501. ''    msvidc.drv
  502. ''
  503. '' 2) Add the above files to your release directory. US versions can be 
  504. ''    found in the \SYSTEM subdirectory of your Viewer disc. French and
  505. ''    German versions were not available at ship time. Please contact 
  506. ''    Microsoft or check the Multimedia Viewer section on the Microsoft
  507. ''    Compuserve Forum for further details.
  508. ''
  509. '' 3) Uncomment the following lines:
  510. ''
  511.  CreateIniKeyValue "WIN.INI", "mci extensions", "AVI", "AVIVIDEO", cmoNone
  512.  CreateIniKeyValue MakePath(GetWindowsDir(), "SYSTEM.INI"), "mci", "AVIVIDEO", "MCIAVI.DRV", cmoNone
  513.  CreateIniKeyValue MakePath(GetWindowsDir(), "SYSTEM.INI"), "drivers", "vidc.msvc", "msvidc.drv", cmoNone
  514.  CreateIniKeyValue MakePath(GetWindowsDir(), "SYSTEM.INI"), "drivers", "vidc.rt21", "indeo.drv", cmoNone
  515.  
  516. END SUB
  517.  
  518.  
  519.  
  520.